Added or corrected Commentary sections
authorEric S. Raymond <esr@snark.thyrsus.com>
Mon, 22 Mar 1993 05:42:35 +0000 (05:42 +0000)
committerEric S. Raymond <esr@snark.thyrsus.com>
Mon, 22 Mar 1993 05:42:35 +0000 (05:42 +0000)
16 files changed:
lisp/emulation/mlconvert.el
lisp/emulation/mlsupport.el
lisp/man.el
lisp/mouse.el
lisp/netunam.el
lisp/novice.el
lisp/options.el
lisp/play/mpuz.el
lisp/progmodes/modula2.el
lisp/progmodes/prolog.el
lisp/rect.el
lisp/textmodes/nroff-mode.el
lisp/textmodes/ooutline.el
lisp/textmodes/page.el
lisp/textmodes/paragraphs.el
lisp/textmodes/picture.el

index 20b51466e4f1ebcaf7a23c5931e72923fb03a17f..c186622e43b1caef840138653e1b6b3d64db1cea 100644 (file)
@@ -3,7 +3,7 @@
 ;; Copyright (C) 1985 Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
-;; Keywords: extensions
+;; Keywords: emulations
 
 ;; This file is part of GNU Emacs.
 
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This package conversts Mocklisp code written under a Gosling or UniPress
+;; Emacs for use with GNU Emacs.  The translated code will require runtime
+;; support from the mlsupport.el equivalent.
+
 ;;; Code:
 
 ;;;###autoload
index c5091b70434e4071d31b86b1eacb8a09e245f4c2..63576d52f8b307b6bacdfee53bb011c6bd8c040a 100644 (file)
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This package provides equivalents of certain primitives from Gosling
+;; Emacs (including the commercial UniPress versions).  These have an
+;; ml- prefix to distinguish them from native GNU Emacs functions with
+;; similar names.  The oackage mlconvert.el translates Mocklisp code
+;; to use these names.
+
 ;;; Code:
 
 (defmacro ml-defun (&rest defs)
index 1f367fc7a6e6b9023d94d3d7b441c0b0b0732e43..6461f3f24477abf02d27a418ef8399e12650731b 100644 (file)
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This package provides an equivalent of the UNIX man(1) command within
+;; Emacs.  The single entry point is `manual-entry'.
+
 ;;; Code:
 
 ;;;###autoload
index aca35b309943d6fb6968b6cc6a6fbf513ab152e2..0b3a1824f94d7652589eb47e6d2935443ba7e0be 100644 (file)
 ;;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This package provides various useful commands (including help
+;; system access) through the mouse.  All this code assumes that mouse
+;; interpretation has been abstracted into Emacs input events.
+;;
+;; The code is rather X-dependent.
+
 ;;; Code:
 
 ;;; Utility functions.
index 21fb36afc03eb333d9da8af907b974a0e34006d5..492ac9b2c120ce2a70b04e8101541c01c0b7c145 100644 (file)
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; Use the Remote File Access (RFA) facility of HP-UX from Emacs.
+
 ;;; Code:
 
 (defconst rfa-node-directory "/net/"
index 1590a1048610d72cfe76a907eaba2c1d5ca17b33..2ddbbac325052bd2df0d34a242220be1d2071ba9 100644 (file)
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This mode provides a hook which is, by default, attached to various
+;; putatively dangerous commands in a (probably futile) attempt to
+;; prevent lusers from shooting themselves in the feet.
+
 ;;; Code:
 
 ;; This function is called (by autoloading)
index 0b831a5ad5a48b229298c854712a6932066f972e..ca78256b562c0b8aa691ab54ae209644a2ad7074 100644 (file)
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This code provides functions to list and edit the values of all global
+;; option variables known to loaded Emacs Lisp code.  There are two entry
+;; points, `list-options' and `edit' options'.  The latter enters a major
+;; mode specifically for editing option values.  Do `M-x describe-mode' in
+;; that context for more details.
+
 ;;; Code:
 
 ;;;###autoload
index 28811924470a5145fb093ebf317ad7133983c10b..4cdb252be0cfaed844d2e678915848c1a7f4ae00 100644 (file)
 ;; file named COPYING.  Among other things, the copyright notice
 ;; and this notice must be preserved on all copies.
 
+;;; Commentary:
+
+;; When this package is loaded, `M-x mpuz' generates a random multiplication
+;; puzzle.  This is a multiplication example in which each digit has been
+;; consistently replaced with some letter.  Your job is to reconstruct
+;; the original digits.  Type `?' while the mode is active for detailed help.
+
 ;;; Code:
 
 (random t)                             ; randomize
index fd261980d800c237827766bf1a31c0191cb059da..21b7d475b30559af247452809de1b5b840d0f01f 100644 (file)
 ;; Author Mick Jordan
 ;; amended Peter Robinson
 
+;;; Commentary:
+
+;; A major mode for editing Modula-2 code.  It provides convenient abbrevs
+;; for Modula-2 keywords, knows about the standard layout rules, and supports
+;; a native compile command.
+
 ;;; Code:
 
 ;;; Added by Tom Perrine (TEP)
index d6b93b70a42697a860152c171fd6d4093c9eba63..52b65113073a18a7b2d307ecf13605259e0f4087 100644 (file)
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This package provides a major mode for editing Prolog.  It knows
+;; about Prolog syntax and comments, and can send regions to an inferior
+;; Prolog interpreter process.
+
 ;;; Code:
 
 (defvar prolog-mode-syntax-table nil)
index 6c2ae12817a8836d8be5fb81fb1bfa5d8ffb53fb..e440904912faf43db60cb4f696161fbcb5f48288 100644 (file)
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This package provides the operations on rectangles that are ocumented
+;; in the Emacs manual.
+
 ;;; Code:
 
 (defun operate-on-rectangle (function start end coerce-tabs)
index 5c87ca567ff1d084b316c49eea425a12e8e9154f..273e8ee201b5734116485473e9ff3666db6b8ecb 100644 (file)
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This package is a major mode for editing nroff source code.  It knows
+;; about various nroff constructs, ms, mm, and me macros, and will fill
+;; and indent paragraphs properly in their presence.  It also includes
+;; a command to count text lines (excluding nroff constructs), a command
+;; to center a line, and movement commands that know how to skip macros.
+
 ;;; Code:
 
 (defvar nroff-mode-abbrev-table nil
index 1712f4b56822bb3d2e0ca648df29f28e20e34620..19ee1f70b297b187bd735fcf2c238b52c211aa1a 100644 (file)
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This package is a major mode for editing outline-format documents.
+;; An outline can be `abstracted' to show headers at any given level,
+;; with all stuff below hidden.  See the Emacs manual for details.
+
 ;;; Code:
 
 ;; Jan '86, Some new features added by Peter Desnoyers and rewritten by RMS.
index 9d57cb18ecff364f635bb3ab4a4bbdd3cf14dc1d..fca4d9f66085460f75eda01771e6e995d26a6b61 100644 (file)
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This code provides the page-oriented movement and selection commands
+;; documented in the Emacs manual.
+
 ;;; Code:
 
 (defun forward-page (&optional count)
index e404a995cf7b63bfc54e9139830e2004d679937c..baebf2d23ffd7d16ec97ec1db0420d2e7b4590d3 100644 (file)
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This package provides the paragraph-oriented commands documented in the
+;; Emacs manual.
+
 ;;; Code:
 
 (defconst paragraph-start "^[ \t\n\f]" "\
index 622269bec1b2ce95df53a931f5f395a0e8b2bcf2..a0864a79c0fc4bbab3f6318087e7aad931e897ce 100644 (file)
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Commentary:
+
+;; This code provides the picture-mode commands documented in the Emacs 
+;; manual.  The screen is treated as a semi-infinite quarter-plane with
+;; support for rectangle operations and `etch-a-sketch' character
+;; insertion in any of eight directions.
+
 ;;; Code:
 
 (defun move-to-column-force (column)